package com.xy.webadmin.app.service;

import com.xy.webadmin.app.model.*;
import com.xy.common.core.base.service.IBaseService;

import java.util.*;

/**
 * 班级数据操作服务接口。
 *
 * @author xiaoyue
 * @date 2025-05-13
 */
public interface ClazzService extends IBaseService<Clazz, Long> {

    /**
     * 保存新增对象。
     *
     * @param clazz 新增对象。
     * @return 返回新增对象。
     */
    Clazz saveNew(Clazz clazz);

    /**
     * 利用数据库的insertList语法，批量插入对象列表。
     *
     * @param clazzList 新增对象列表。
     */
    void saveNewBatch(List<Clazz> clazzList);

    /**
     * 更新数据对象。
     *
     * @param clazz         更新的对象。
     * @param originalClazz 原有数据对象。
     * @return 成功返回true，否则false。
     */
    boolean update(Clazz clazz, Clazz originalClazz);

    /**
     * 删除指定数据。
     *
     * @param id 主键Id。
     * @return 成功返回true，否则false。
     */
    boolean remove(Long id);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     * 如果需要同时获取关联数据，请移步(getClazzListWithRelation)方法。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Clazz> getClazzList(Clazz filter, String orderBy);

    /**
     * 获取主表的查询结果，以及主表关联的字典数据和一对一从表数据，以及一对一从表的字典数据。
     * 该查询会涉及到一对一从表的关联过滤，或一对多从表的嵌套关联过滤，因此性能不如单表过滤。
     * 如果仅仅需要获取主表数据，请移步(getClazzList)，以便获取更好的查询性能。
     *
     * @param filter 主表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Clazz> getClazzListWithRelation(Clazz filter, String orderBy);

    /**
     * 判断指定对象是否包含下级对象。
     *
     * @param id 主键Id。
     * @return 存在返回true，否则false。
     */
    boolean hasChildren(Long id);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回不与指定主表主键Id存在对多对关系的列表。
     *
     * @param studentId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Clazz> getNotInClazzListByStudentId(Long studentId, Clazz filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id存在对多对关系的列表。
     *
     * @param studentId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param studentClazzFilter 多对多关联表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Clazz> getClazzListByStudentId(
            Long studentId, Clazz filter, StudentClazz studentClazzFilter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id列表存在对多对关系的列表。
     *
     * @param studentList 主表对象集合。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return key是主表的主键Id，value是多对多从表的对象列表。
     */
    Map<Long, List<Clazz>> getClazzListMapByStudentList(
            List<Student> studentList, Clazz filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回不与指定主表主键Id存在对多对关系的列表。
     *
     * @param teacherId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Clazz> getNotInClazzListByTeacherId(Long teacherId, Clazz filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id存在对多对关系的列表。
     *
     * @param teacherId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param teacherClazzFilter 多对多关联表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<Clazz> getClazzListByTeacherId(
            Long teacherId, Clazz filter, TeacherClazz teacherClazzFilter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id列表存在对多对关系的列表。
     *
     * @param teacherList 主表对象集合。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return key是主表的主键Id，value是多对多从表的对象列表。
     */
    Map<Long, List<Clazz>> getClazzListMapByTeacherList(
            List<Teacher> teacherList, Clazz filter, String orderBy);

    /**
     * 批量添加多对多关联关系。
     *
     * @param studentClazzList 多对多关联表对象集合。
     * @param clazzId 主表Id。
     */
    void addStudentClazzList(List<StudentClazz> studentClazzList, Long clazzId);

    /**
     * 更新中间表数据。
     *
     * @param studentClazz 中间表对象。
     * @return 更新成功与否。
     */
    boolean updateStudentClazz(StudentClazz studentClazz);

    /**
     * 获取中间表数据。
     *
     * @param clazzId 主表Id。
     * @param studentId 从表Id。
     * @return 中间表对象。
     */
    StudentClazz getStudentClazz(Long clazzId, Long studentId);

    /**
     * 移除单条多对多关系。
     *
     * @param clazzId 主表Id。
     * @param studentId 从表Id。
     * @return 成功返回true，否则false。
     */
    boolean removeStudentClazz(Long clazzId, Long studentId);

    /**
     * 批量移除单条多对多关系。
     *
     * @param clazzId 主表Id。
     * @param studentIdList 从表Id列表。
     */
    void removeStudentClazzList(Long clazzId, List<Long> studentIdList);

    /**
     * 批量添加多对多关联关系。
     *
     * @param teacherClazzList 多对多关联表对象集合。
     * @param clazzId 主表Id。
     */
    void addTeacherClazzList(List<TeacherClazz> teacherClazzList, Long clazzId);

    /**
     * 更新中间表数据。
     *
     * @param teacherClazz 中间表对象。
     * @return 更新成功与否。
     */
    boolean updateTeacherClazz(TeacherClazz teacherClazz);

    /**
     * 获取中间表数据。
     *
     * @param clazzId 主表Id。
     * @param teacherId 从表Id。
     * @return 中间表对象。
     */
    TeacherClazz getTeacherClazz(Long clazzId, Long teacherId);

    /**
     * 移除单条多对多关系。
     *
     * @param clazzId 主表Id。
     * @param teacherId 从表Id。
     * @return 成功返回true，否则false。
     */
    boolean removeTeacherClazz(Long clazzId, Long teacherId);

    /**
     * 批量移除单条多对多关系。
     *
     * @param clazzId 主表Id。
     * @param teacherIdList 从表Id列表。
     */
    void removeTeacherClazzList(Long clazzId, List<Long> teacherIdList);
}
